Renamed @sei-js/evm to @sei-js/precompiles#259
Conversation
🦋 Changeset detectedLatest commit: a047553 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| "include": ["./library"], | ||
| "compilerOptions": { | ||
| "outDir": "./dist" | ||
| }, |
There was a problem hiding this comment.
Fixed small typedoc issues in other packages, but this wont affect their builds and doesn't need a release. Just noticed as I was updating the comments inside the /precompiles package
There was a problem hiding this comment.
Pull Request Overview
This PR renames the @sei-js/evm package to @sei-js/precompiles, adjusts related imports and examples, and adds Typedoc configuration updates across several packages.
- Rename package identifier, import paths, and documentation to reflect new
@sei-js/precompilesname - Update example code paths and category tags in Ethers contract factories
- Add Typedoc options in various
tsconfig.jsonfiles and update coverage flags
Reviewed Changes
Copilot reviewed 66 out of 66 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/precompiles/src/ethers/ibcPrecompile.ts | Updated type imports, example import path, and tags |
| packages/precompiles/src/ethers/governancePrecompile.ts | Fixed example import, updated parseEther usage, and tags |
| packages/precompiles/src/ethers/distributionPrecompile.ts | Updated type imports, example path, and tags |
| packages/precompiles/src/ethers/confidentialTransfersPrecompile.ts | Updated example import and tags |
| packages/precompiles/src/ethers/bankPrecompile.ts | Switched to ETHERS_BANK_PRECOMPILE_ABI, updated imports and tags |
| packages/precompiles/src/ethers/addressPrecompile.ts | Updated type imports, example path, and tags |
| packages/precompiles/package.json | Renamed package and updated description |
| packages/precompiles/README.md | Added new README for @sei-js/precompiles |
| packages/precompiles/CHANGELOG.md | Updated package header |
| packages/ledger/tsconfig.json | Corrected Typedoc project name |
| packages/evm/README.md | Removed outdated EVM README content |
| packages/create-sei/tsconfig.json | Added Typedoc options |
| packages/create-sei/package.json | Added docs script and formatting |
| packages/cosmos/tsconfig.json | Added Typedoc options |
| codecov.yml | Changed coverage flag from evm to precompiles |
| README.md | Updated top-level link to @sei-js/precompiles |
| .changeset/great-jars-marry.md | Added changeset entry for renaming |
Comments suppressed due to low confidence (1)
packages/precompiles/README.md:6
- [nitpick] The plural of
ABIshould beABIs(without an apostrophe) rather thanABI's.
TypeScript utilities and helpers for interacting with Sei's precompile contracts. Provides seamless integration with popular Ethereum development tools like Viem and Ethers.js, offering typed interfaces, contract factories, ABI's, contract addresses, and utilities specifically designed for Sei's precompile ecosystem.
| * | ||
| * // Surround with try/catch for detailed errors | ||
| * const depositResponse = await governancePrecompileContract.connect(signer).deposit('1', { value: parseSei(1) }); | ||
| * const depositResponse = await governancePrecompileContract.connect(signer).deposit('1', { value: parseEther(1) }); |
There was a problem hiding this comment.
The parseEther function expects a string argument; passing a number will throw a runtime error. Use parseEther('1') instead of parseEther(1).
| * const depositResponse = await governancePrecompileContract.connect(signer).deposit('1', { value: parseEther(1) }); | |
| * const depositResponse = await governancePrecompileContract.connect(signer).deposit('1', { value: parseEther('1') }); |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #259 +/- ##
=======================================
Coverage 98.16% 98.16%
=======================================
Files 67 67
Lines 763 763
Branches 128 128
=======================================
Hits 749 749
Misses 14 14 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…name-evm-to-precompiles
* Renamed `@sei-js/evm` to `@sei-js/precompiles` * Added changeset * Removed and hid test files * Fixed TypeDoc issues * More typedoc fixes * Fixed broken tests due to local chain id change * Fixed ABI in ethers precompile * Updated yarn lock
Rename
@sei-js/evmto@sei-js/precompilesAs these precompiles were the only thing in here, this package is to be renamed to
@sei-js/precompilesso that docs and LLMs can better understand it's purpose.Local Chain ID in Viem
This updates to the new local chain ID that doesn't conflict with devnet.
Typedoc Fixes
This PR also fixes various TypeDoc issues and has more clear docs comments .